Update Pass Template Distribution Restrictions

Update Pass Template Distribution Restrictions

Update the distribution restrictions of the pass template.

Parameters:

• restrictions (TemplateRestrictions): The updated distribution restrictions data.
• template (Template): The pass template.

Returns:

• dict: The updated distribution restrictions of the pass template.

PUT /v2/templates/{templateId}/restrictions

Update Pass Template Distribution Restrictions

cURL

curl --request PUT \
  --url https://api.loyalty.dog/v2/templates/{templateId}/restrictions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "quantityRestriction": 123,
  "redemptionRestriction": 123,
  "passwordProtection": "<string>",
  "sharingRestriction": true,
  "dateRestriction": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.loyalty.dog/v2/templates/{templateId}/restrictions"

payload = {
    "quantityRestriction": 123,
    "redemptionRestriction": 123,
    "passwordProtection": "<string>",
    "sharingRestriction": True,
    "dateRestriction": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    quantityRestriction: 123,
    redemptionRestriction: 123,
    passwordProtection: '<string>',
    sharingRestriction: true,
    dateRestriction: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.loyalty.dog/v2/templates/{templateId}/restrictions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.loyalty.dog/v2/templates/{templateId}/restrictions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'quantityRestriction' => 123,
    'redemptionRestriction' => 123,
    'passwordProtection' => '<string>',
    'sharingRestriction' => true,
    'dateRestriction' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.loyalty.dog/v2/templates/{templateId}/restrictions"

	payload := strings.NewReader("{\n  \"quantityRestriction\": 123,\n  \"redemptionRestriction\": 123,\n  \"passwordProtection\": \"<string>\",\n  \"sharingRestriction\": true,\n  \"dateRestriction\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.loyalty.dog/v2/templates/{templateId}/restrictions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"quantityRestriction\": 123,\n  \"redemptionRestriction\": 123,\n  \"passwordProtection\": \"<string>\",\n  \"sharingRestriction\": true,\n  \"dateRestriction\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.loyalty.dog/v2/templates/{templateId}/restrictions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"quantityRestriction\": 123,\n  \"redemptionRestriction\": 123,\n  \"passwordProtection\": \"<string>\",\n  \"sharingRestriction\": true,\n  \"dateRestriction\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization · string · header · required

JWT access token obtained from POST /v2/token.

Headers

authorization · string | null

Path Parameters

templateId · Templateid · string Templateid · string · required

Required string length: 24

Pattern: ^[0-9a-f]{24}$

Example:

"5eb7cf5a86d9755df3a6c593"

Body

application/json

quantityRestriction · integer | null

redemptionRestriction · integer | null

passwordProtection · string | null

sharingRestriction · boolean | null

dateRestriction · string<date-time> | null

returningUserRestriction · enum<string> | null

Available options: user_decides, show_existing, create_new

passSharingMethod · enum<string> | null

Available options: pass, url, disabled

Response

200

application/json

Successful Response